home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / BBS / PB201SW.ZIP / MANUAL.LZH / WIPDOC.TXT < prev   
Encoding:
Text File  |  1996-04-02  |  13.4 KB  |  372 lines
  1. Windows Interface Protocol and Powerboard 2.0
  2. ---------------------------------------------
  3.  
  4. CONCEPT
  5. -------
  6.  
  7. The Windows Interface Protocol is a fast and efficient way to make use
  8. of the various functions available in Microsoft Windows, over a live
  9. connection (Internet or dial-up).  In other words, WIP is a method of
  10. interfacing an online service with Windows (hence the name Windows
  11. Interface Protocol).
  12.  
  13. The idea behind WIP is very simple: allow an online service to make use
  14. of the resources available on the user's Windows system.  This includes
  15. full 24-bit graphics, true-type fonts, stereo sound, icons, buttons,
  16. etc.  One of the more powerful features of WIP is that it can run
  17. client/server applications real-time.  From the programmers' viewpoint,
  18. this is similar to Java (a language for the Web) in that applications
  19. made to interface with WIP can be seamlessly integrated into the online
  20. service.
  21.  
  22. Because WIP is a client/server protocol, the server (host) and the
  23. client (the user's computer) are in a constant dialogue while connected
  24. to each other.  Unlike the scanario when a user is calling from an
  25. ASCII, ANSI or RIPscrip based system, the client is not a dumb terminal.
  26. In a fashion similar to America Online's automatic graphics updating, a
  27. WIP client/server system will only send graphics, sound, or WIP
  28. applications if the client either does not have the data or it needs to
  29. be updated.  With this increased efficiency, it actually becomes a
  30. viable option to send large graphics, sound and application files since
  31. they only need to be sent once.
  32.  
  33. ACCESSING A POWERBOARD SYSTEM IN WIP MODE
  34. -----------------------------------------
  35.  
  36. In order to access a Powerboard 2.0 system in WIP mode, the caller must
  37. be calling with a WIP compatible terminal program.  As of this writing, 
  38. the only WIP terminal program available is DC Term by Durand 
  39. Communications.  DC Term is a freeware program, which means that you can
  40. give it to your callers without paying any royalty fees.  However, DC Term
  41. is still copyrighted, and the copyright specifies that you cannot charge
  42. anyone for the DC Term software.
  43.  
  44. DC Term is available from the NuIQ Software Support BBS, as well as from
  45. our Web site and Ftp site (http://www.nuiq.com and ftp://ftp.nuiq.com,
  46. respectively).
  47.  
  48.  
  49. DESIGNING WIP SCREENS
  50. ---------------------
  51.  
  52. Designing a WIP screen is rather simple.  A program called the WIP Builder
  53. (available from NuIQ Software and from Durand Communications) allows you 
  54. to actually draw your screens.  Any Sysop who has been drawing ANSI screens 
  55. for the past ten years will certainly be able to appreciate this move to 
  56. an intuitive WYSIWYG graphical design utility.  Creating a WIP screen is 
  57. just a matter of drawing it!  The Interface Builder has a toolbox from 
  58. which several tool-types can be selected.  Among these are text, text-box, 
  59. button, and picture.  If, for example, a Sysop wants to create a field in 
  60. which data can be entered, he needs only to click on the text-box tool and 
  61. draw the field on the screen.  Graphical files such as .GIFs and .JPGs 
  62. can be integrated just as easily.  Just click on the picture tool and 
  63. draw an outline for the graphic where you want it on the screen.  The
  64. graphic will be dropped into the area you drew immediately.
  65.  
  66.  
  67. CHANGING ICONS ON DEFAULT MENUS
  68. -------------------------------
  69.  
  70. Even without the DC Interface Builder (or WIP Builder) software from Durand
  71. Communications, you can still change the icons found on the WIP menus.  
  72. Icons for these menus are located in the WIP\RESOURCE\ subdirectory (which
  73. branches off your main BBS directory).  The file exit.ico, for instance, is
  74. the picture of a man walking through a door.  This is used throughout the
  75. default WIP interface on Powerboard 2.0 to represent the way that the user
  76. can exit the current screen or function.
  77.  
  78. When menus are built with the MenuCfg and Menu Developer (MDEV) software,
  79. the file wipmacro.dat is read.  Wipmacro.dat is a text file but it is 
  80. formatted in a special way so that MenuCfg and Menu Developer can get
  81. the information they need from it in a fast and accurate manner.  Each
  82. line in the wipmacro.dat file is for a specific BBS function.  The following
  83. line is the line from Wipmacro.dat for the Goodbye/Logoff function:
  84.  
  85. CONTROL\MACROS\BYE.CTL|Goodbye/Logoff|Goodbye|Click on this option if you wish to disconnect from this BBS.|DRIVEIN.ICO|TOP
  86.  
  87. In the above example, the first item on the line is the path and filename 
  88. for the PCL script itself (see the PCL section of the Powerboard Manual
  89. for more information on the Powerboard Control Language).  
  90.  
  91. The second item is the text description of the macro that is used in the
  92. macros.dat file.  Macros.dat is the list of PCL macros that is used by 
  93. Menu Developer for building ANSI, ASCII and RIPscrip menus.  
  94.  
  95. The third item on the line is the text that should appear on the WIP
  96. menu for this option.
  97.  
  98. The fourth item is the help text for the option that will appear if the
  99. user leaves their mouse pointer on the button for a while without clicking.
  100.  
  101. The fifth option is the filename in the WIP\RESOURCE\ directory for the 
  102. icon to be associated with this option.
  103.  
  104. The sixth and last option is the type of command this is.  Command types 
  105. are: TOP (for the top of the menu where constant options are listed); 
  106. MENUS (for options that should go under the Menus heading); MULTINODE;
  107. MISC; MESSAGES; SEARCH; and TRANSFERS.
  108.  
  109.  
  110. You'll notice that the options are seperated by pipe bars.  The pipe bar
  111. is ascii character #124 and can be generated by turning on the num lock
  112. on your keyboard, then holding down the ALT key while typing 124 on the
  113. numeric keypad.  Most keyboards also have the pipe bar key on top of the
  114. backslash.  When this is the case, you can generate a pipe bar symbol by
  115. holding down the SHIFT key and pressing the backslash key on the keyboard.
  116.  
  117.  
  118. .GIF AND .JPG GRAPHICS USED IN DEFAULT SCREENS
  119. ----------------------------------------------
  120.  
  121. The following screens, located in the WIP\RESOURCE\ directory, are used
  122. in WIP screens on your BBS by default:
  123.  
  124. boathmv.jpg - Used on the "goodbye" screen.  Picture of people on a boat
  125. departing for a foreign land.
  126.  
  127. arcdet.gif - l'Arc de Triumph, a famous landmark in Paris that welcomes
  128. visitors to the city.
  129.  
  130.  
  131. .WAV STEREO SOUNDS USED BY DEFAULT
  132. ----------------------------------
  133.  
  134. im.wav - Played when a user receives an "Instant Message" from someone
  135. on another node.
  136.  
  137. goodbye.wav - Played when the user hangs up.
  138.  
  139. wakeup!.wav - Played when the user is idle for a while.
  140.  
  141. welcome.wav - Played when the user logs on the first time in a given day.
  142.  
  143.  
  144. ADDING WIP SOUNDS
  145. -----------------
  146.  
  147. WIP sounds can be played in any procedure on the BBS when the system is
  148. in Enhanced WIP mode.  Adding a WIP sound is a matter of inserting a 
  149. couple of lines into an approprate control file (PCL program).  For
  150. more information on the Powerboard Control Language, consult the
  151. PCL section of the Powerboard Manual.
  152.  
  153. The following two lines are used in the macro BYE.CTL in order to play the
  154. goodbye.wav sound:
  155.  
  156. setnv(file=goodbye.wav)
  157. loadsub(control\wipsound.ctl)
  158.  
  159.  
  160. ADDING WIP SCREENS
  161. ------------------
  162.  
  163. Enhanced WIP screens can be displayed in a similar way to how WIP sounds
  164. can be played.  It is a matter of adding a line or two in an appropriate
  165. control file.  Again, if you are not familiar with PCL, consult that
  166. section in the Powerboard Manual.  The following line is used to display
  167. the enhanced WIP screen goodbye.wip in the bye.ctl macro:
  168.  
  169. loadsub(control\newdisp.ctl,setnv(file=goodbye))
  170.  
  171. In actuality, there are two lines used to display the file.  The line above,
  172. plus a line that sets an option for displaying the goodbye screen:
  173. setnv(NoInfo=1)
  174.  
  175. This line sets the NoInfo variable to 1.  When set to 1 (as opposed to 
  176. zero), the NoInfo variable tells the WIP display routine not to wait for
  177. input from the user.  If you'd like for the WIP display routine to display
  178. the ASCII equivalent of the WIP screen locally (just to the Sysop) while
  179. the WIP screen is being displayed to the user, add the following line 
  180. before calling the newdisp.ctl program:
  181.  
  182. setnv(asciiequiv=1)
  183.  
  184.  
  185. THINGS TO BE AWARE OF WHEN MODIFYING WIP SCREENS
  186. ------------------------------------------------
  187.  
  188. When creating or modifying WIP screens with the DC Interface Builder,
  189. keep the following in mind:
  190.  
  191. .wi0 files are WIP screens that Powerboard will read in and scan for
  192. percent codes (see Percent Codes section of the Powerboard Manual)
  193. before displaying.
  194.  
  195. OKAY buttons should generally have an object name of 'Okay'.  This is
  196. what the WIP display routine looks for.
  197.  
  198. The following screens must have some specific object names.  They are
  199. as follows.
  200.  
  201. FILENAME            REQUIRED OBJECT NAMES & DESCRIPTIONS
  202. --------            ------------------------------------
  203. changef.wip            Exit - Button to exit screen
  204.                 Help - Button to obtain help
  205.                 listbox - Scrollable listbox where area
  206.                 names and numbers are displayed
  207.  
  208. chg.wip             Exit - Button to exit screen
  209.                 Help - Button to obtain help
  210.                 listbox - Scrollable listbox where area
  211.                 names and numbers are displayed
  212.  
  213. bulltmpl.wi0            updated - text file box with UPDATED.%NODE%
  214.                 attached
  215.                 Okay - to exit screen
  216.  
  217. chgtmpl.wi0            Bulletin - text file box with %NV%TEXT%
  218.                 attached
  219.                 Okay - to exit screen
  220.  
  221. edittag.wip            Exit - to exit screen
  222.                 E - to edit tag list
  223.                 listbox - scrollable list box
  224.                 A - to add files
  225.  
  226. flist.wip            listbox - scrollable list box
  227.                 status - Text field (non-editable)
  228.                 Tag - button
  229.                 Download Mode - button
  230.                 View - button
  231.                 Exit - to exit screen
  232.  
  233. inbox.wip            msgs - list box
  234.                 Exit - to exit screen
  235.  
  236. inmsg.wip            msgtxt - list box
  237.                 prev - button
  238.                 next - button
  239.                 help - button
  240.                 forward - button
  241.                 reply - button
  242.                 kill - button
  243.                 compose - button
  244.                 Exit - button
  245.                 compose - button
  246.                 Exit - to exit screen
  247.                 msgnt - text box (non-editable)
  248.                 msgnumber - text box (non-editable)
  249.                 varf - text box (non-editable)
  250.                 sentont - text box (non-editable)
  251.                 sentd - text box (non-editable)
  252.                 att - text box (non-editable)
  253.                 sentt - text box (non-editable)
  254.                 sentbt - text box (non-editable)
  255.                 addrt - text box (non-editable)
  256.                 regt - text box (non-editable)
  257.                 statt - text box (non-editable)
  258.                 sentb - text box (non-editable)
  259.                 addrto - text box (non-editable)
  260.                 regarding - text box (non-editable)
  261.                 status - text box (non-editable)
  262.                 attachinfo - text box (non-editable)
  263.                 attt - text box (non-editable)
  264.                 Download - button
  265.                 keep - button
  266.  
  267. inmsg-s.wip            Same object as 'inmsg.wip' plus:
  268.                 UserFile - button
  269.  
  270. mscan.wip            stop - Exit screen
  271.                 nosel1 - button
  272.  
  273. multtmpl.wip            listbox - list box
  274.                 Exit - exit screen
  275.  
  276. newf.wip            date - editable text box
  277.                 Okay - exit screen
  278.  
  279. newstmpl.wi0            newsltr - text file box with newsltr.no
  280.                 attached
  281.                 done - exit screen
  282.  
  283. newuser.wip            nosel1 - button
  284.                 conametxt - text box (non-editable)
  285.                 titTxt - text box (non-editable)
  286.                 str1txt - text box (non-editable)
  287.                 str2txt - text box (non-editable)
  288.                 csttxt - text box (non-editable)
  289.                 cntxt - text box (non-editable)
  290.                 pstlctxt - text box (non-editable)
  291.                 aliastxt - text box (non-editable)
  292.                 pwtxt - text box (non-editable)
  293.                 hphtxt - text box (non-editable)
  294.                 wphtxt - text box (non-editable)
  295.                 DobTxt - text box (non-editable)
  296.                 comptxt - text box (non-editable)
  297.                 okbtn - exit screen
  298.                 company - text box (editable)
  299.                 title - text box (editable)
  300.                 street1 - text box (editable)
  301.                 street2 - text box (editable)
  302.                 cityst - text box (editable)
  303.                 country - text box (editable)
  304.                 zipcode - text box (editable)
  305.                 alias - text box (editable)
  306.                 password - text box (editable)
  307.                 homephone - text box (editable)
  308.                 workphone - text box (editable)
  309.                 dob - text box (editable)
  310.                 computer - text box (editable)
  311.  
  312. newuser1.wi0            Proceed - exit screen
  313.  
  314. readfile.wip            filename - editable text box
  315.                 listbox - list box
  316.                 Exit - exit screen
  317.  
  318. searchf.wip            text - editable text box
  319.                 Okay - exit screen
  320.  
  321. secinfo.wi0            name - text box (non-editable)
  322.                 timelim - text box (non-editable)
  323.                 graphm - text box (non-editable)
  324.                 newck - text box (non-editable)
  325.                 firstcl - text box (non-editable)
  326.                 lastcl - text box (non-editable)
  327.                 timeson - text box (non-editable)
  328.                 accessinf - text file box with
  329.                 DISPLAY\SEC/:SEC/.NO attached
  330.                 Okay - exit screen
  331.  
  332. sendinst.wip            node - editable text box
  333.                 /WHO - button
  334.                 message - editable text box
  335.                 Send - button
  336.                 Exit - exit screen
  337.  
  338. stats.wip            password - editable text box
  339.                 cityst - editable text box
  340.                 voice - editable text box
  341.                 company - editable text box
  342.                 street - editable text box
  343.                 mhsname - editable text box
  344.                 work - editable text box
  345.                 screenlen - editable text box
  346.                 attach - Button
  347.                 music - Button
  348.                 fullscr - Button
  349.                 avail - Button
  350.                 graphics - Button
  351.                 personal - Button
  352.                 newf - Button
  353.                 Okay - exit screen
  354.                 protocol - Button
  355.  
  356. stats-a.wip            Same as stats.wip but with:
  357.                 alias - editable text box
  358.  
  359. tag.wip                filename - editable text box
  360.                 Tag - button
  361.                 Exit - exit screen
  362.  
  363. welcome.wip            nameprompt - editable text box
  364.                 password - editable text box
  365.                 welcometext - unclickable Button
  366.                 logon - Button
  367.  
  368. userfind.wip            searchtext - editable text box
  369.                 begin - Button
  370.                 listbox - list box
  371.                 quit - Button
  372.